ソフトバンクまとめて支払い(都度決済) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranSb 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
JobCd		必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount		必須半角数字6桁利用金額
Tax		半角数字5桁税送料

URL

/payment/EntryTranSb.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranSb 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
RetURL		必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。ソフトバンクセンター上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。
PaymentTermSec		半角数字5桁支払開始期限秒お客様が【決済実行】から【決済開始】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。

URL

/payment/ExecTranSb.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive

レスポンス

正常

AccessID		半角英数32桁固定取引ID
Token		半角英数256桁固定トークン取引IDのハッシュ値を返却します。
StartURL		半角英数記号256桁支払手続き開始IFのURL 決済開始IFのURLを返却します。
StartLimitDate		半角数字14桁固定支払開始期限日時決済開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=107c44550ac7f47cbc6dbef22c4c27fd&StartURL=https://x01.mul-pay.jp/payment/SbStart.idPass&StartLimitDate=20220722112429

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SbStart 決済開始

お客様をソフトバンクセンターへ誘導します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数256桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/SbStart.idPass

リクエストパラメータ

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=7zTgGKeccFSXt1GD2aA0aO1NpliOjXE9kynelaJET0SwBS7yYvxSiC0zeMVH+O4F

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="SbStartCall" action="{SbStartURL}" method="POST">
    <noscript>
      <center>
        <h2>ソフトバンクまとめて支払い（B）の決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.SbStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>

リダイレクト後、お客様はソフトバンクまとめて支払い（B）の画面へ遷移します。

決済結果受信

ソフトバンクセンターから、当サービスに認証・支払操作結果が通知されます。認証・支払操作結果は、お客様が支払操作を完了した場合と認証・支払操作をキャンセルした場合に通知されます。当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。

レスポンス

正常

ShopID		半角英数13桁固定ショップID
OrderID		半角英数記号27桁オーダーID
Status		現状態該当取引の取引状態を返却します。 AUTH：仮売上 CAPTURE：即時売上 PAYFAIL：決済失敗
TranDate		半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
SbTrackingId		半角英数14桁ソフトバンク処理トラッキングID

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20220101010000&SbTrackingId=20220101010000

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SbSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字6桁利用金額
Tax		半角数字5桁税送料

URL

/payment/SbSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態実売上成功時は以下のステータスが返却されます。・SALES：実売上
Amount		半角数字6桁利用金額
Tax		半角数字5桁税送料

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SbCancel キャンセル

決済が完了した取引に対して決済内容のキャンセルを行います。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
CancelAmount		必須半角数字6桁キャンセル金額
CancelTax		半角数字5桁キャンセル税送料

URL

/payment/SbCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
Status		現状態キャンセル成功時は以下のステータスが返却されます。・CANCEL：キャンセルキャンセル失敗時はキャンセル処理前のステータスが返却されます。
CancelAmount		半角数字6桁キャンセル金額
CancelTax		半角数字5桁キャンセル税送料

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&CancelAmount=1000&CancelTax=0

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引情報参照

対象取引の取引状態を取得します。

リクエスト

ShopID		必須半角英数13桁固定ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字2桁決済方法 11：ソフトバンクまとめて支払い(都度決済・随時決済)

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=11

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証処理中 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 PAYFAIL：決済失敗 CANCEL：キャンセル
ProcessDate		半角数字14桁固定処理日時処理を実施した日時を返却します。 yyyyMMddHHmmss書式
JobCd		処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字10桁利用金額
Tax		半角数字10桁税送料
Currency		半角数字3桁通貨コード決済に利用された通貨を返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 11：ソフトバンクまとめて支払い(都度決済・随時決済)
PaymentTerm		半角数字14桁固定支払期限日時 yyyyMMddHHmmss書式
SbTrackingId		半角英数14桁ソフトバンク処理トラッキングID
SbCancelAmount		半角数字5桁ソフトバンクキャンセル金額
SbCancelTax		半角数字5桁ソフトバンクキャンセル税送料
SbAcceptCode		半角英数14桁 SB承諾番号

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20220808143025&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&Currency=&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=11&PaymentTerm=20220808153008&SbTrackingId=12345678901234&SbCancelAmount=1000&SbCancelTax=0&SbAcceptCode=12345678765432

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001